skip incomplete API reference generations#304
Closed
thebiglabasky wants to merge 1 commit into
Closed
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Affected Components
Notes for the Reviewer
Adds a quality gate to the generated API endpoint PR workflow. The generator now skips undocumented operations when the OpenAPI metadata is too incomplete to render a useful Mintlify API Reference page.
For now it skips operations that:
defaultresponse/v1/accounts/{accountId}/membersThis prevents creating technically valid MDX stubs that render as poor API docs because the upstream OpenAPI operation lacks response/status/schema/parameter detail.
Validation:
node --check .github/scripts/detect-new-endpoints.mjsDRY_RUN=1 node .github/scripts/detect-new-endpoints.mjsThe dry run now skips the incomplete account members, cancel, and v2 check-session operations and only keeps endpoints with enough metadata to render useful reference pages.
New Dependency Submission
None.
Screenshots
No visual changes.